Muze

The starting point of the visualization system is muze. Multiple canvases - each containing its own visualization - can be created from muze.

muze also contains a number of utilities (e.g. ActionModel, Operators etc.) that help customise the visualizations to create more sophisticated visualizations.

A Muze instance can be retrieved from the global [viz] object by simply accessing its muze property.

const { muze } = viz;

canvas(settings?)

Properties	Type	Required	Default	Description
settings	object	❎	-	Contains canvas specific settings that dictate the canvas' behaviour
settings.isPrintMode	boolean	❎	false	When true, optimizes Muze's internal scheduler for print output. This is an advanced setting and should only be used in rare cases if it turns out that attempting to print a page with a visualization results in it not being shown in print.

Creates and returns a Canvas instance for building visualizations. The optional settings parameter allows you to configure the canvas properties.

const canvas = muze.canvas();

DataModel

Provides access to the DataModel class which allows one to create high-performance, in-memory data tables.

const { DataModel } = muze;

version

Provides the version of muze that is currently being used.

const { version } = muze;

ActionModel

Provides access to the ActionModel utility class which allows customizing the interaction behaviour of a created visualization.

const { ActionModel } = muze;

Operators

Provides access to a couple of helpful Operators (html, share etc.) that simplify boilerplate when creating more advanced visualizations.

const { Operators } = muze;